// Pipeline Component Library Example
// ----------------------------------
// Colin Bowern (colinbowern@hotmail.com)
// January 2007
//
// Copyright (c) 2007 Colin Bowern
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// * The above copyright notice and this permission notice shall be included in
//   all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

#region References
using Microsoft.CommerceServer.Runtime;
using System;
using System.Diagnostics;
#endregion

namespace RockstarGuys.PipelineComponents
{
    /// <summary>
    /// Represents a purchase order payment.
    /// </summary>
    /// <remarks>
    /// For more information see http://msdn2.microsoft.com/en-us/library/microsoft.commerceserver.runtime.orders.purchaseorderpayment.aspx
    /// </remarks>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1710:IdentifiersShouldHaveCorrectSuffix"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1035:ICollectionImplementationsHaveStronglyTypedMembers"), DebuggerDisplay("PaymentId = {PaymentId}")]
    public class PurchaseOrderPayment : Payment
    {
        #region Properties
        /// <remarks />
        public string PurchaseOrderPaymentNumber
        {
            get { return this[PurchaseOrderPayment.KeyNames.PurchaseOrderPaymentNumber] as string; }
            set { this[PurchaseOrderPayment.KeyNames.PurchaseOrderPaymentNumber] = value; }
        }
        #endregion

        #region Constructor
        /// <summary>
        /// Initializes a new instance of the <see cref="PurchaseOrderPayment"/> class.
        /// </summary>
        /// <remarks>
        /// The underlying store can be persisted through referencing the InnerDictionary property.
        /// </remarks>
        public PurchaseOrderPayment()
            : base()
        {
            this.PurchaseOrderPaymentNumber = string.Empty;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="PurchaseOrderPayment"/> class.
        /// </summary>
        /// <param name="container">The container.</param>
        [CLSCompliant(false)]
        public PurchaseOrderPayment(IDictionary container) : base(container) { }
        #endregion

        #region Nested Types
        /// <summary>
        /// Keys used to access the properties in the dictionary.
        /// </summary>
        [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1815:OverrideEqualsAndOperatorEqualsOnValueTypes"), System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1034:NestedTypesShouldNotBeVisible")]
        public new struct KeyNames
        {
            /// <remarks />
            public const string PurchaseOrderPaymentNumber = "purchase_order_payment_number";
        }
        #endregion
    }
}